// ASM: a very small and fast Java bytecode manipulation framework
// Copyright (c) 2000-2011 INRIA, France Telecom
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// 1. Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
// 2. Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
// 3. Neither the name of the copyright holders nor the names of its
//    contributors may be used to endorse or promote products derived from
//    this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
// THE POSSIBILITY OF SUCH DAMAGE.
package org.springframework.asm;

/**
 * 一个访问Java注解的访问者。
 * 这个类的方法必须以下列方式调用顺序:
 * ( {@code visit} | {@code visitEnum} |
 * {@code visitAnnotation} | {@code visitArray} ) | {@code visitEnd}.
 *
 * @author Eric Bruneton
 * @author Eugene Kuleshov
 */
public abstract class AnnotationVisitor {

  /**
   * 该访问者实现的ASM API版本。这个字段的值必须是{@link Opcodes#ASM4}、
   * {@link Opcodes#ASM5}、{@link Opcodes#ASM6}或{@link Opcodes#ASM7}之一。
   */
  protected final int api;

  /**
   * 该访问者必须委托方法调用的注释访问者。可以是{@literal null}。
   */
  protected AnnotationVisitor av;

  /**
   * 构建一个新的{@link AnnotationVisitor}。
   *
   * @param api 该访问者实现的ASM API版本。
   *            必须是{@link Opcodes#ASM4}、{@link Opcodes#ASM5}、{@link Opcodes#ASM6}或{@link Opcodes#ASM7}之一。
   */
  public AnnotationVisitor(final int api) {
    this(api, null);
  }

  /**
   * 构建一个新的{@link AnnotationVisitor}。
   *
   * @param api 该访问者实现的ASM API版本。
   *            必须是{@link Opcodes#ASM4}、{@link Opcodes#ASM5}、{@link Opcodes#ASM6}或{@link Opcodes#ASM7}之一。
   * @param annotationVisitor 的注释访问者，该访问者必须将方法委托给该注释访问者的调用。可以是{@literal null}。
   */
  public AnnotationVisitor(final int api, final AnnotationVisitor annotationVisitor) {
    if (api != Opcodes.ASM9
        && api != Opcodes.ASM8
        && api != Opcodes.ASM7
        && api != Opcodes.ASM6
        && api != Opcodes.ASM5
        && api != Opcodes.ASM4
        && api != Opcodes.ASM10_EXPERIMENTAL) {
      throw new IllegalArgumentException("Unsupported api " + api);
    }
    // SPRING PATCH: 没有对ASM实验性的预览模式检查
    this.api = api;
    this.av = annotationVisitor;
  }

  /**
   * 访问注解的一个原始值。
   *
   * @param name 值的名称。
   * @param value 实际值，其类型必须是{@link Byte}, {@link Boolean}, {@link Character},
   * 					{@link Short}, {@link Integer}, {@link Long}, {@link Float}, {@link Double},
   * 					{@link Long}, {@link Float}, {@link Double},{@link String}或{@link Type}的
   *             		{@link Type#OBJECT}或{@link Type#ARRAY}排序。
   *              		这个值也可以是一个由byte、boolean、short、char、int、long、float或double值组成的数组。
   *              		（这等同于使用{@link #visitArray}并依次访问每个数组元素。但更方便）。)
   */
  public void visit(final String name, final Object value) {
    if (av != null) {
      av.visit(name, value);
    }
  }

  /**
   * 访问一个注释的枚举值。
   *
   * @param name 值的名称。
   * @param descriptor 枚举类的类描述符。
   * @param value 实际枚举值。
   */
  public void visitEnum(final String name, final String descriptor, final String value) {
    if (av != null) {
      av.visitEnum(name, descriptor, value);
    }
  }

  /**
   * 访问一个嵌套注解的注解值。
   *
   * @param name 值的名称。
   * @param descriptor 嵌套注解类的类描述符。
   * @return 访客访问实际的嵌套注解值，或者如果这个访客对访问这个嵌套注解不感兴趣，则{@literal null}。
   * 		 访客对访问这个嵌套注解不感兴趣。<i>嵌套注解值在调用这个注解访问者的其他方法之前必须被完全访问</i>。
   */
  public AnnotationVisitor visitAnnotation(final String name, final String descriptor) {
    if (av != null) {
      return av.visitAnnotation(name, descriptor);
    }
    return null;
  }

  /**
   *  访问一个注释的数组值。注意，原始值的数组（如byte,boolean, short, char, int, long, float or double）
   *  可以作为值传递给{@link #visit visit}。
   *  这就是{@link ClassReader}对非空的原始值数组的作用。
   *
   * @param name 值的名称。
   * @return 访客访问实际的数组值元素，如果这个访客对访问这些值不感兴趣，则{@literal null}。
   * 		对访问这些值不感兴趣。传递给该访问者的方法的'name'参数被忽略。
   * 		的方法所传递的'name'参数会被忽略。<i>在调用该注释访问者的其他方法之前，必须访问所有的数组值方法之前必须访问所有的数组值</i>。
   */
  public AnnotationVisitor visitArray(final String name) {
    if (av != null) {
      return av.visitArray(name);
    }
    return null;
  }

  /** 访问注释的结尾。 */
  public void visitEnd() {
    if (av != null) {
      av.visitEnd();
    }
  }
}
